<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>http::basic_parser::put</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../boost__beast__http__basic_parser.html" title="http::basic_parser">
<link rel="prev" href="skip/overload2.html" title="http::basic_parser::skip (2 of 2 overloads)">
<link rel="next" href="put_eof.html" title="http::basic_parser::put_eof">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="skip/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="put_eof.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__http__basic_parser.put"></a><a class="link" href="put.html" title="http::basic_parser::put">http::basic_parser::put</a>
</h5></div></div></div>
<p>
          <a class="indexterm" name="idm44861289802416"></a>
        </p>
<p>
          Write a buffer sequence to the parser.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.put.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.put.synopsis"></a></span><a class="link" href="put.html#beast.ref.boost__beast__http__basic_parser.put.synopsis">Synopsis</a>
        </h6>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">&gt;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
<span class="identifier">put</span><span class="special">(</span>
    <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.put.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.put.description"></a></span><a class="link" href="put.html#beast.ref.boost__beast__http__basic_parser.put.description">Description</a>
        </h6>
<p>
          This function attempts to incrementally parse the HTTP message data stored
          in the caller provided buffers. Upon success, a positive return value indicates
          that the parser made forward progress, consuming that number of bytes.
          In some cases there may be an insufficient number of octets in the input
          buffer in order to make forward progress. This is indicated by the code
          <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">need_more</span></code></a>.
          When this happens, the caller should place additional bytes into the buffer
          sequence and call <a class="link" href="put.html" title="http::basic_parser::put"><code class="computeroutput"><span class="identifier">put</span></code></a> again. The error code <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">need_more</span></code></a>
          is special. When this error is returned, a subsequent call to <a class="link" href="put.html" title="http::basic_parser::put"><code class="computeroutput"><span class="identifier">put</span></code></a> may succeed if the buffers
          have been updated. Otherwise, upon error the parser may not be restarted.
        </p>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.put.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.put.parameters"></a></span><a class="link" href="put.html#beast.ref.boost__beast__http__basic_parser.put.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">buffers</span></code>
                  </p>
                </td>
<td>
                  <p>
                    An object meeting the requirements of <span class="emphasis"><em>ConstBufferSequence</em></span>
                    that represents the next chunk of message data. If the length
                    of this buffer sequence is one, the implementation will not allocate
                    additional memory. The class <a class="link" href="../boost__beast__basic_flat_buffer.html" title="basic_flat_buffer"><code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">basic_flat_buffer</span></code></a> is
                    provided as one way to meet this requirement
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ec</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Set to the error, if any occurred.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="beast.ref.boost__beast__http__basic_parser.put.h3"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.put.return_value"></a></span><a class="link" href="put.html#beast.ref.boost__beast__http__basic_parser.put.return_value">Return
          Value</a>
        </h6>
<p>
          The number of octets consumed in the buffer sequence. The caller should
          remove these octets even if the error is set.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="skip/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="put_eof.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
